<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>UniMRCP: mrcp_recorder_header_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UniMRCP
   &#160;<span id="projectnumber">1.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">mrcp_recorder_header_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="mrcp__recorder__header_8h_source.html">mrcp_recorder_header.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a15ea557cd414a651dbc8723b16904adf"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a15ea557cd414a651dbc8723b16904adf">sensitivity_level</a></td></tr>
<tr class="separator:a15ea557cd414a651dbc8723b16904adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6022f0ae8476c071cd0318d94a225541"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a6022f0ae8476c071cd0318d94a225541">no_input_timeout</a></td></tr>
<tr class="separator:a6022f0ae8476c071cd0318d94a225541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d97cb9acf5fa15d2974e4c3c1487ac8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mrcp__recorder__header_8h.html#aff48af630664fc9badad6d8532306180">mrcp_recorder_completion_cause_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a4d97cb9acf5fa15d2974e4c3c1487ac8">completion_cause</a></td></tr>
<tr class="separator:a4d97cb9acf5fa15d2974e4c3c1487ac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada09cabb6cceaec2a95a64dbc7d17efe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#ada09cabb6cceaec2a95a64dbc7d17efe">completion_reason</a></td></tr>
<tr class="separator:ada09cabb6cceaec2a95a64dbc7d17efe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad22a224d3077fb9ec409db3730502030"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#ad22a224d3077fb9ec409db3730502030">failed_uri</a></td></tr>
<tr class="separator:ad22a224d3077fb9ec409db3730502030"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a265f0f4ee63362a7f4943452ff0ac7c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a265f0f4ee63362a7f4943452ff0ac7c0">failed_uri_cause</a></td></tr>
<tr class="separator:a265f0f4ee63362a7f4943452ff0ac7c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5786075f87f31b537f02088540b5dd19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a5786075f87f31b537f02088540b5dd19">record_uri</a></td></tr>
<tr class="separator:a5786075f87f31b537f02088540b5dd19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a254a28013f0bd24b7f358e7f7602e756"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a254a28013f0bd24b7f358e7f7602e756">media_type</a></td></tr>
<tr class="separator:a254a28013f0bd24b7f358e7f7602e756"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87f0fb193f25f21cf08fbbc3b1e3fbbc"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a87f0fb193f25f21cf08fbbc3b1e3fbbc">max_time</a></td></tr>
<tr class="separator:a87f0fb193f25f21cf08fbbc3b1e3fbbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16af02fbe99d31a1282a529af1e01320"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a16af02fbe99d31a1282a529af1e01320">trim_length</a></td></tr>
<tr class="separator:a16af02fbe99d31a1282a529af1e01320"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90917032d9ce5eeffb8ec08c6674cd2e"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a90917032d9ce5eeffb8ec08c6674cd2e">final_silence</a></td></tr>
<tr class="separator:a90917032d9ce5eeffb8ec08c6674cd2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec83e51c8c9ee81e04e4dfa851f8f5df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#aec83e51c8c9ee81e04e4dfa851f8f5df">capture_on_speech</a></td></tr>
<tr class="separator:aec83e51c8c9ee81e04e4dfa851f8f5df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76a8d4c5275e541cf83cf7d919ce37c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a76a8d4c5275e541cf83cf7d919ce37c1">ver_buffer_utterance</a></td></tr>
<tr class="separator:a76a8d4c5275e541cf83cf7d919ce37c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40a37ecce2b475cb3cffe973a5b494a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a40a37ecce2b475cb3cffe973a5b494a0">start_input_timers</a></td></tr>
<tr class="separator:a40a37ecce2b475cb3cffe973a5b494a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1be8f6c660a216e6a5063ea3ae497a33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__recorder__header__t.html#a1be8f6c660a216e6a5063ea3ae497a33">new_audio_channel</a></td></tr>
<tr class="separator:a1be8f6c660a216e6a5063ea3ae497a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MRCP recorder-header </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aec83e51c8c9ee81e04e4dfa851f8f5df"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_recorder_header_t::capture_on_speech</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>f false, the recorder MUST start capturing immediately when started. If true, the recorder MUST wait for the endpointing functionality to detect speech before it starts capturing </p>

</div>
</div>
<a class="anchor" id="a4d97cb9acf5fa15d2974e4c3c1487ac8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="mrcp__recorder__header_8h.html#aff48af630664fc9badad6d8532306180">mrcp_recorder_completion_cause_e</a> mrcp_recorder_header_t::completion_cause</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MUST be part of a RECORD-COMPLETE event coming from the recorder resource to the client </p>

</div>
</div>
<a class="anchor" id="ada09cabb6cceaec2a95a64dbc7d17efe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_recorder_header_t::completion_reason</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be specified in a RECORD-COMPLETE event coming from the recorder resource to the client </p>

</div>
</div>
<a class="anchor" id="ad22a224d3077fb9ec409db3730502030"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_recorder_header_t::failed_uri</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a recorder method needs to post the audio to a URI and access to the URI fails, the server MUST provide the failed URI in this header in the method response </p>

</div>
</div>
<a class="anchor" id="a265f0f4ee63362a7f4943452ff0ac7c0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_recorder_header_t::failed_uri_cause</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a recorder method needs to post the audio to a URI and access to the URI fails, the server MUST provide the URI specific or protocol specific response code through this header in the method response </p>

</div>
</div>
<a class="anchor" id="a90917032d9ce5eeffb8ec08c6674cd2e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">apr_size_t mrcp_recorder_header_t::final_silence</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When recorder is started and the actual capture begins, this header specifies the length of silence in the audio that is to be interpreted as the end of the recording </p>

</div>
</div>
<a class="anchor" id="a87f0fb193f25f21cf08fbbc3b1e3fbbc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">apr_size_t mrcp_recorder_header_t::max_time</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When recording is started this specifies the maximum length of the recording in milliseconds, calculated from the time the actual capture and store begins and is not necessarily the time the RECORD method is received </p>

</div>
</div>
<a class="anchor" id="a254a28013f0bd24b7f358e7f7602e756"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_recorder_header_t::media_type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A RECORD method MUST contain this header, which specifies to the server the Media Type of the captured audio or video </p>

</div>
</div>
<a class="anchor" id="a1be8f6c660a216e6a5063ea3ae497a33"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_recorder_header_t::new_audio_channel</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be specified in a RECORD request and allows the client to tell the server that, from this point on, further input audio comes from a different audio source </p>

</div>
</div>
<a class="anchor" id="a6022f0ae8476c071cd0318d94a225541"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">apr_size_t mrcp_recorder_header_t::no_input_timeout</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When recording is started and there is no speech detected for a certain period of time, the recorder can send a RECORD-COMPLETE event </p>

</div>
</div>
<a class="anchor" id="a5786075f87f31b537f02088540b5dd19"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_recorder_header_t::record_uri</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a recorder method contains this header the server must capture the audio and store it </p>

</div>
</div>
<a class="anchor" id="a15ea557cd414a651dbc8723b16904adf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float mrcp_recorder_header_t::sensitivity_level</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>To filter out background noise and not mistake it for speech </p>

</div>
</div>
<a class="anchor" id="a40a37ecce2b475cb3cffe973a5b494a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_recorder_header_t::start_input_timers</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be sent as part of the RECORD request. A value of false tells the recorder resource to start the operation, but not to start the no-input timer until the client sends a START-INPUT-TIMERS </p>

</div>
</div>
<a class="anchor" id="a16af02fbe99d31a1282a529af1e01320"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">apr_size_t mrcp_recorder_header_t::trim_length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This header MAY be sent on a STOP method and specifies the length of audio to be trimmed from the end of the recording after the stop </p>

</div>
</div>
<a class="anchor" id="a76a8d4c5275e541cf83cf7d919ce37c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_recorder_header_t::ver_buffer_utterance</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Tells the server to buffer the utterance associated with this recording request into the verification buffer </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mrcp__recorder__header_8h_source.html">mrcp_recorder_header.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2017 10:11:48 for UniMRCP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
